home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / APC / .tmpINSTALL < prev    next >
Text File  |  2004-03-24  |  10KB  |  254 lines
  1. Installation Instructions for APC
  2. ---------------------------------
  3.  
  4. APC has been successfully compiled on the following platforms:
  5.  
  6.     o Linux (RH 6.2/7.2/7.3/8)
  7.     o FreeBSD
  8.     o OpenBSD
  9.     o MacOS 10.2 (statically compiled)
  10.  
  11. ...and has been tested with the following PHP versions:
  12.  
  13.     o 4.2.2
  14.     o 4.2.3
  15.     o 4.3.0
  16.     o 4.3.2
  17.  
  18. Versions prior to 4.2.2 have been officially deprecated by the PHP group, and
  19. therefore aren't supported by APC either.
  20.  
  21. +---------------------+
  22. | QUICK INSTALL (DSO) |
  23. +---------------------+
  24.  
  25. These instructions assume your PHP installation is located in /usr/local/php.
  26.  
  27. $ gunzip -c apc_x.y.tar.gz | tar xf -
  28. $ cd apc_x.y
  29. $ /usr/local/php/bin/phpize
  30. $ ./configure --enable-apc
  31. $ make
  32. $ make install
  33.  
  34. You will probably need to run the final command (make install) as root.
  35.  
  36. The above sequence of commands will install a .so file in your PHP
  37. installation extension directory. The output of make install should display
  38. that path to the screen.
  39.  
  40. Next you must edit your php.ini file, which is normally located in
  41. /usr/local/php/lib/php.ini, and add the following line:
  42.  
  43.     extension="apc.so"
  44.  
  45. Replace "/path/to/php/extensions" with whatever path was displayed when you
  46. ran make install above.
  47.  
  48. Then restart your web server and consult the output of phpinfo(). If there is
  49. an informational section for APC, the installation was successful.
  50.  
  51. +------------------------+
  52. | QUICK INSTALL (Static) |
  53. +------------------------+
  54.  
  55. APC will not successfully compile on all systems as a DSO. If you run into
  56. problems using the DSO quick install, you can try to compile it statically
  57. into PHP. (The DSO install is recommended, though.)
  58.  
  59. These instructions assume the current directory is the root of the PHP source
  60. tree, and that you have already configured PHP by running its bundled
  61. configure script.
  62.  
  63. $ cd ext
  64. $ gunzip -c apc_x.y.tar.gz | tar xf -
  65. $ cd ..
  66. $ ./buildconf
  67. $ ./config.nice
  68. $ make
  69. $ make install
  70.  
  71. Once this is complete, simply restart your web server. You do not need to
  72. modify your php.ini file to enable APC.
  73.  
  74. +-----------------+
  75. | VERBOSE INSTALL |
  76. +-----------------+
  77.  
  78. These instructions assume your PHP installation is located in /usr/local/php.
  79.  
  80. 1.  Unpack your distribution file.
  81.  
  82.     You will have downloaded a file named something like apc_x.y.tar.gz.
  83.     Unzip this file with a command like
  84.     
  85.         gunzip apc_x.y.tar.gz
  86.     
  87.     Next you have to untar it with
  88.     
  89.         tar xvf apc_x.y.tar
  90.  
  91.     This will create an apc_x.y directory. cd into this new directory:
  92.  
  93.         cd apc_x.y
  94.  
  95. 2.  Run phpize.
  96.  
  97.     phpize is a script that should have been installed with PHP, and is
  98.     normally located in /usr/local/php/bin assuming you installed PHP in
  99.     /usr/local/php. (If you do not have the phpize script, you must reinstall
  100.     PHP and be sure not to disable PEAR.)
  101.  
  102.     Run the phpize command:
  103.     
  104.         /usr/local/php/bin/phpize
  105.  
  106.     Its output should resemble this:
  107.  
  108.         autoheader: `config.h.in' is created
  109.         You should update your `aclocal.m4' by running aclocal.
  110.         Configuring for:
  111.           PHP Api Version:   20020918
  112.           Zend Module Api No:   20020429
  113.           Zend Extension Api No:   20021010
  114.  
  115.     phpize should create a configure script in the current directory. If you
  116.     get errors instead, you might be missing some required development tools,
  117.     such as autoconf or libtool. You can try downloading the latest versions
  118.     of those tools and running phpize again.
  119.  
  120. 3.  Run the configure script.
  121.  
  122.     phpize creates a configure script. The only option you need to specify is
  123.     the location of your php-config script:
  124.  
  125.         ./configure --with-enable-apc
  126.  
  127.     php-config should be located in the same directory as phpize.
  128.  
  129.     If you prefer to use mmap instead of the default IPC shared memory support,
  130.     add --enable-mmap to your configure line.  If you don't understand the 
  131.     difference between the two, stick with the default.
  132.  
  133.     If you prefer to use sysv IPC semaphores over the safer fcntl() locks, add
  134.     --enable-sem to your configure line.  If you don't have a problem
  135.     with your server segaulting, or any other unnatural accumulation of
  136.     semaphores on your system, the semaphore based locking is slightly faster.
  137.  
  138. 4.  Compile and install the files. Simply type: make install
  139.  
  140.     (You may need to be root in order to install)
  141.  
  142.     If you encounter errors from libtool or gcc during this step, please
  143.     contact the project maintainer (dcowgill@php.net).
  144.  
  145. 5.  Edit your php.ini
  146.  
  147.     make install should have printed a line resembling the following:
  148.  
  149.         Installing shared extensions: /path/to/extension/
  150.  
  151.     Copy the path /path/to/extension/ and add the following line to your
  152.     php.ini file (normally located in /usr/local/php/lib/php.ini):
  153.  
  154.         extension="apc.so"
  155.  
  156.     If you don't have a php.ini file in that location, you can create it now.
  157.  
  158. 6.  Restart the web server and test the installation.
  159.  
  160.     Restart your web server now (for apache, it's apachectl restart) and
  161.     create a small test PHP file in your document root. The file should
  162.     contain just the following line:
  163.  
  164.         <?php phpinfo() ?>
  165.  
  166.     Request that file in a web browser. If there is an entry for APC in the
  167.     list of installed modules, the installation was successful.
  168.  
  169.     If APC is not listed, consult your web server error log. If it contains an
  170.     error message saying that it can't load the APC extension, your system
  171.     might not be able to load shared libraries created with PHP's build
  172.     system. One alternative would be to compile APC statically into PHP. See
  173.     the Quick Install (Static) instructions above.
  174.  
  175.     You should consult your error log anyway to see if APC generated any
  176.     errors. On BSD-based platforms, it is typical for APC to be unable to
  177.     allocate the default-sized shared memory segment. See below for hints on
  178.     raising your system's shared memory limitations.
  179.  
  180. If all else fails, ask for help on the APC mailing list. Visit
  181. http://apc.communityconnect.com/ for more information.
  182.  
  183. +-----------------+
  184. | CONFIGURING APC |
  185. +-----------------+
  186.  
  187. Although the default APC settings are fine for many installations, serious
  188. users should consider tuning the following parameters:
  189.  
  190.     OPTION                  DESCRIPTION
  191.     ------------------      --------------------------------------------------
  192.     apc.enabled             This can be set to 0 to disable APC. This is
  193.                             primarily useful when APC is statically compiled
  194.                             into PHP, since there is no other way to disable
  195.                             it (when compiled as a DSO, the zend_extension
  196.                             line can just be commented-out).
  197.                             (Default: 1)
  198.                             
  199.     apc.shm_segments        The number of shared memory segments to allocate
  200.                             for the compiler cache. If APC is running out of
  201.                             shared memory but you have already set
  202.                             apc.shm_size as high as your system allows, you
  203.                             can try raising this value.
  204.                             (Default: 1)
  205.                             
  206.     apc.shm_size            The size of each shared memory segment in MB.
  207.                             By default, some systems (including most BSD
  208.                             variants) have very low limits on the size of a
  209.                             shared memory segment.
  210.                             (Default: 30)
  211.                             
  212.     apc.optimization        The optimization level. Zero disables the
  213.                             optimizer, and higher values use more aggressive
  214.                             optimizations. Expect very modest speed
  215.                             improvements. This is experimental.
  216.                             (Default: 0)
  217.     
  218.     apc.num_files_hint      A "hint" about the number of distinct source files
  219.                             that will be included or requested on your web
  220.                             server. Set to zero or omit if you're not sure;
  221.                             this setting is mainly useful for sites that have
  222.                             many thousands of source files.
  223.                             (Default: 1000)
  224.  
  225.     apc.gc_ttl              The number of seconds that a cache entry may
  226.                             remain on the garbage-collection list. This value
  227.                             provides a failsafe in the event that a server
  228.                             process dies while executing a cached source file;
  229.                             if that source file is modified, the memory
  230.                             allocated for the old version will not be
  231.                             reclaimed until this TTL reached. Set to zero to
  232.                             disable this feature.
  233.                             (Default: 3600)
  234.  
  235.     apc.filters             A comma-separated list of POSIX extended regular
  236.                             expressions. If any pattern matches the source
  237.                             filename, the file will not be cached. Note that
  238.                             the filename used for matching is the one passed
  239.                             to include/require, not the absolute path.
  240.                             (Default: "")
  241.  
  242.     apc.mmap_file_mask      If compiled with MMAP support by using --enable-mmap
  243.                             this is the mktemp-style file_mask to pass to the
  244.                             mmap module for determing whether your mmap'ed memory
  245.                             region is going to be file-backed or shared memory
  246.                             backed.  For straight file-backed mmap, set it to
  247.                             something like /tmp/apc.XXXXXX (exactly 6 X's).
  248.                             To use POSIX-style shm_open/mmap put a ".shm"
  249.                             somewhere in your mask.  eg.  "/apc.shm.XXXXXX"
  250.                             You can also set it to "/dev/zero" to use your 
  251.                             kernel's /dev/zero interface to anonymous mmap'ed 
  252.                             memory.  Leaving it undefined will force an 
  253.                             anonymous mmap.
  254.